package com.egg.common.swagger.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author east
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface SwaggerDisplayAnnotation {

    /*
      使用方法：
       1. 在需要展示的枚举类中添加 该注解 @SwaggerDisplayEnum
       2. 在枚举类中 重写 toString() 方法，该方法解决枚举在文档中展示的样子
            例如 ：
                toString() {
                    return message + ":" + code;
                }
       3. 在接口文档字段上添加  @ApiModelProperty 注解，并在 notes 属性 写入完整的枚举路径字符串
            例如 ：
                @ApiModelProperty(value = "示例", notes = "com.egg.demo.enums.DemoEnum")
                private String demo;
       4. 展示效果 【 fields;(message:code) 】
     */

}